/*
 * Copyright 2006 Matt Jensen
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.spectaql.internal.query;

/**
 * <p>
 * <code>AbstractSingleValueEqualityConstraint</code> is a common base for all equality constraints which compare their
 * targets to a single value.
 * </p>
 * <p>
 * <strong>Thread Safety:</strong> Instances of this class are thread safe. 
 * </p>
 */
abstract class AbstractSingleValueEqualityConstraint<T> implements EqualityConstraint
{
    /**
     * <p>
     * The value to which the target will be compared. 
     * </p>
     */
    private final T m_value;

    /**
     * <p>
     * Construct a {@link AbstractSingleValueEqualityConstraint} instance.
     * </p>
     *
     * @param value the value to which the target will be compared.
     */
    public AbstractSingleValueEqualityConstraint(final T value)
    {
        super();

        m_value = value;
    }

    /**
     * <p>
     * Get the value to which the target will be compared.
     * </p>
     *
     * @return {@link Object} value.
     */
    public T getValue()
    {
        return m_value;
    }

    /* inherit javadoc */
    @Override
    public String toString()
    {
        return String.format("%s[value=%s]", getClass().getName(), m_value);
    }
}
